/*
 * The MIT License
 *
 * Copyright 2011 Seiji Sogabe
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

package hudson.markup;

import edu.umd.cs.findbugs.annotations.NonNull;
import hudson.Extension;
import hudson.Util;
import java.io.IOException;
import java.io.Writer;
import org.jenkinsci.Symbol;
import org.kohsuke.stapler.DataBoundConstructor;

/**
 * {@link MarkupFormatter} that treats the input as the escaped html.
 *
 * @author Seiji Sogabe
 * @since 1.553
 */
public class EscapedMarkupFormatter extends MarkupFormatter {

    @DataBoundConstructor
    public EscapedMarkupFormatter() {
    }

    @Override
    public void translate(String markup, Writer output) throws IOException {
        if (markup != null) {
            output.write(Util.escape(markup));
        }
    }

    @Extension @Symbol("plainText")
    public static class DescriptorImpl extends MarkupFormatterDescriptor {

        @NonNull
        @Override
        public String getDisplayName() {
            return Messages.EscapedMarkupFormatter_DisplayName();
        }
    }

}
